CreateStorageUnitRefIterator

Inside Macintosh: OpenDoc Class Reference /: Part 1 - Classes and Methods / ODStorageUnit

CreateStorageUnitRefIterator
The CreateStorageUnitRefIterator method creates a storage-unit reference iterator for the currently focused value.
ODStorageUnitRefIterator CreateStorageUnitRefIterator ();
return value
A reference to a storage-unit reference iterator used to traverse all persistent references in the currently focused value.

DISCUSSION
You can call this method if you need to perform an operation on all storage-unit references in the currently focused value.
While you are using the returned storage-unit reference iterator, you must not modify the focused value; in particular, you must not call any of the following methods of this storage unit: DeleteValue, Internalize, Remove, RemoveStorageUnitRef, SetStorageUnitRef, SetType, or SetValue. Furthermore, you must not delete this storage unit.
You must delete the returned storage-unit reference iterator when it is no longer needed.

EXCEPTIONS

kODErrUnfocusedStorageUnit
This storage unit is not focused on a value.
kODErrZeroRefCount
This storage unit has a reference count of 0.

SEE ALSO
The ODStorageUnitRefIterator class (page 721).
Table 11-1 on page 466 in OpenDoc Programmer's Guide.